<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html><head><title>QTextCodec Class Reference</title><style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
td.postheader { font-family: sans-serif }
tr.address { font-family: sans-serif }
body { background: #ffffff; color: black; }
</style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">&#160;&#160;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&#160;&#183; <a href="classes.html"><font color="#004faf">All Classes</font></a>&#160;&#183; <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QTextCodec Class Reference<br /><sup><sup>[<a href="qtcore.html">QtCore</a> module]</sup></sup></h1><p>The QTextCodec class provides conversions between text
encodings. <a href="#details">More...</a></p>

<h3>Types</h3><ul><li><div class="fn" />enum <b><a href="qtextcodec.html#ConversionFlag-enum">ConversionFlag</a></b> { DefaultConversion, ConvertInvalidToNull, IgnoreHeader }</li><li><div class="fn" />class <b><a href="qtextcodec-conversionflags.html">ConversionFlags</a></b></li><li><div class="fn" />class <b><a href="qtextcodec-converterstate.html">ConverterState</a></b></li></ul><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qtextcodec.html#QTextCodec">__init__</a></b> (<i>self</i>)</li><li><div class="fn" />list-of-QByteArray <b><a href="qtextcodec.html#aliases">aliases</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qtextcodec.html#canEncode">canEncode</a></b> (<i>self</i>, QString)</li><li><div class="fn" />QString <b><a href="qtextcodec.html#convertToUnicode">convertToUnicode</a></b> (<i>self</i>, str&#160;<i>in</i>, ConverterState&#160;<i>state</i>)</li><li><div class="fn" />QByteArray <b><a href="qtextcodec.html#fromUnicode">fromUnicode</a></b> (<i>self</i>, QString&#160;<i>uc</i>)</li><li><div class="fn" />QTextDecoder <b><a href="qtextcodec.html#makeDecoder">makeDecoder</a></b> (<i>self</i>)</li><li><div class="fn" />QTextDecoder <b><a href="qtextcodec.html#makeDecoder-2">makeDecoder</a></b> (<i>self</i>, ConversionFlags&#160;<i>flags</i>)</li><li><div class="fn" />QTextEncoder <b><a href="qtextcodec.html#makeEncoder">makeEncoder</a></b> (<i>self</i>)</li><li><div class="fn" />QTextEncoder <b><a href="qtextcodec.html#makeEncoder-2">makeEncoder</a></b> (<i>self</i>, ConversionFlags&#160;<i>flags</i>)</li><li><div class="fn" />int <b><a href="qtextcodec.html#mibEnum">mibEnum</a></b> (<i>self</i>)</li><li><div class="fn" />QByteArray <b><a href="qtextcodec.html#name">name</a></b> (<i>self</i>)</li><li><div class="fn" />QString <b><a href="qtextcodec.html#toUnicode">toUnicode</a></b> (<i>self</i>, QByteArray)</li><li><div class="fn" />QString <b><a href="qtextcodec.html#toUnicode-2">toUnicode</a></b> (<i>self</i>, str&#160;<i>chars</i>)</li><li><div class="fn" />QString <b><a href="qtextcodec.html#toUnicode-3">toUnicode</a></b> (<i>self</i>, str&#160;<i>in</i>, ConverterState&#160;<i>state</i>&#160;=&#160;None)</li></ul><h3>Static Methods</h3><ul><li><div class="fn" />list-of-QByteArray <b><a href="qtextcodec.html#availableCodecs">availableCodecs</a></b> ()</li><li><div class="fn" />list-of-int <b><a href="qtextcodec.html#availableMibs">availableMibs</a></b> ()</li><li><div class="fn" />QTextCodec <b><a href="qtextcodec.html#codecForCStrings">codecForCStrings</a></b> ()</li><li><div class="fn" />QTextCodec <b><a href="qtextcodec.html#codecForHtml">codecForHtml</a></b> (QByteArray&#160;<i>ba</i>)</li><li><div class="fn" />QTextCodec <b><a href="qtextcodec.html#codecForHtml-2">codecForHtml</a></b> (QByteArray&#160;<i>ba</i>, QTextCodec&#160;<i>defaultCodec</i>)</li><li><div class="fn" />QTextCodec <b><a href="qtextcodec.html#codecForLocale">codecForLocale</a></b> ()</li><li><div class="fn" />QTextCodec <b><a href="qtextcodec.html#codecForMib">codecForMib</a></b> (int&#160;<i>mib</i>)</li><li><div class="fn" />QTextCodec <b><a href="qtextcodec.html#codecForName">codecForName</a></b> (QByteArray&#160;<i>name</i>)</li><li><div class="fn" />QTextCodec <b><a href="qtextcodec.html#codecForName-2">codecForName</a></b> (str&#160;<i>name</i>)</li><li><div class="fn" />QTextCodec <b><a href="qtextcodec.html#codecForTr">codecForTr</a></b> ()</li><li><div class="fn" />QTextCodec <b><a href="qtextcodec.html#codecForUtfText">codecForUtfText</a></b> (QByteArray&#160;<i>ba</i>)</li><li><div class="fn" />QTextCodec <b><a href="qtextcodec.html#codecForUtfText-2">codecForUtfText</a></b> (QByteArray&#160;<i>ba</i>, QTextCodec&#160;<i>defaultCodec</i>)</li><li><div class="fn" /><b><a href="qtextcodec.html#setCodecForCStrings">setCodecForCStrings</a></b> (QTextCodec&#160;<i>c</i>)</li><li><div class="fn" /><b><a href="qtextcodec.html#setCodecForLocale">setCodecForLocale</a></b> (QTextCodec&#160;<i>c</i>)</li><li><div class="fn" /><b><a href="qtextcodec.html#setCodecForTr">setCodecForTr</a></b> (QTextCodec&#160;<i>c</i>)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QTextCodec class provides conversions between text
encodings.</p>
<p>Qt uses Unicode to store, draw and manipulate strings. In many
situations you may wish to deal with data that uses a different
encoding. For example, most Japanese documents are still stored in
Shift-JIS or ISO 2022-JP, while Russian users often have their
documents in KOI8-R or Windows-1251.</p>
<p>Qt provides a set of QTextCodec classes to help with converting
non-Unicode formats to and from Unicode. You can also create your
own codec classes.</p>
<p>The supported encodings are:</p>
<ul>
<li>Apple Roman</li>
<li><a href="codec-big5.html">Big5</a></li>
<li><a href="codec-big5hkscs.html">Big5-HKSCS</a></li>
<li>CP949</li>
<li><a href="codec-eucjp.html">EUC-JP</a></li>
<li><a href="codec-euckr.html">EUC-KR</a></li>
<li><a href="codec-gbk.html">GB18030-0</a></li>
<li>IBM 850</li>
<li>IBM 866</li>
<li>IBM 874</li>
<li><a href="codecs-jis.html">ISO 2022-JP</a></li>
<li>ISO 8859-1 to 10</li>
<li>ISO 8859-13 to 16</li>
<li>Iscii-Bng, Dev, Gjr, Knd, Mlm, Ori, Pnj, Tlg, and Tml</li>
<li>JIS X 0201</li>
<li>JIS X 0208</li>
<li>KOI8-R</li>
<li>KOI8-U</li>
<li>MuleLao-1</li>
<li>ROMAN8</li>
<li><a href="codec-sjis.html">Shift-JIS</a></li>
<li>TIS-620</li>
<li><a href="codec-tscii.html">TSCII</a></li>
<li>UTF-8</li>
<li>UTF-16</li>
<li>UTF-16BE</li>
<li>UTF-16LE</li>
<li>UTF-32</li>
<li>UTF-32BE</li>
<li>UTF-32LE</li>
<li>Windows-1250 to 1258</li>
<li>WINSAMI2</li>
</ul>
<p>QTextCodecs can be used as follows to convert some locally
encoded string to Unicode. Suppose you have some string encoded in
Russian KOI8-R encoding, and want to convert it to Unicode. The
simple way to do it is like this:</p>
<pre class="cpp">
 <span class="type"><a href="qbytearray.html">QByteArray</a></span> encodedString <span class="operator">=</span> <span class="string">"..."</span>;
 <span class="type">QTextCodec</span> <span class="operator">*</span>codec <span class="operator">=</span> <span class="type">QTextCodec</span><span class="operator">.</span><a href="qtextcodec.html#codecForName">codecForName</a>(<span class="string">"KOI8-R"</span>);
 <span class="type"><a href="qstring.html">QString</a></span> string <span class="operator">=</span> codec<span class="operator">-</span><span class="operator">&gt;</span><a href="qtextcodec.html#toUnicode">toUnicode</a>(encodedString);
</pre>
<p>After this, <tt>string</tt> holds the text converted to Unicode.
Converting a string from Unicode to the local encoding is just as
easy:</p>
<pre class="cpp">
 <span class="type"><a href="qstring.html">QString</a></span> string <span class="operator">=</span> <span class="string">"..."</span>;
 <span class="type">QTextCodec</span> <span class="operator">*</span>codec <span class="operator">=</span> <span class="type">QTextCodec</span><span class="operator">.</span><a href="qtextcodec.html#codecForName">codecForName</a>(<span class="string">"KOI8-R"</span>);
 <span class="type"><a href="qbytearray.html">QByteArray</a></span> encodedString <span class="operator">=</span> codec<span class="operator">-</span><span class="operator">&gt;</span><a href="qtextcodec.html#fromUnicode">fromUnicode</a>(string);
</pre>
<p>To read or write files in various encodings, use <a href="qtextstream.html">QTextStream</a> and its <a href="qtextstream.html#setCodec">setCodec()</a> function. See the
<a href="tools-codecs.html">Codecs</a> example for an application
of QTextCodec to file I/O.</p>
<p>Some care must be taken when trying to convert the data in
chunks, for example, when receiving it over a network. In such
cases it is possible that a multi-byte character will be split over
two chunks. At best this might result in the loss of a character
and at worst cause the entire conversion to fail.</p>
<p>The approach to use in these situations is to create a <a href="qtextdecoder.html">QTextDecoder</a> object for the codec and use
this <a href="qtextdecoder.html">QTextDecoder</a> for the whole
decoding process, as shown below:</p>
<pre class="cpp">
 <span class="type">QTextCodec</span> <span class="operator">*</span>codec <span class="operator">=</span> <span class="type">QTextCodec</span><span class="operator">.</span><a href="qtextcodec.html#codecForName">codecForName</a>(<span class="string">"Shift-JIS"</span>);
 <span class="type"><a href="qtextdecoder.html">QTextDecoder</a></span> <span class="operator">*</span>decoder <span class="operator">=</span> codec<span class="operator">-</span><span class="operator">&gt;</span><a href="qtextcodec.html#makeDecoder">makeDecoder</a>();

 <span class="type"><a href="qstring.html">QString</a></span> string;
 <span class="keyword">while</span> (new_data_available()) {
     <span class="type"><a href="qbytearray.html">QByteArray</a></span> chunk <span class="operator">=</span> get_new_data();
     string <span class="operator">+</span><span class="operator">=</span> decoder<span class="operator">-</span><span class="operator">&gt;</span>toUnicode(chunk);
 }
 <span class="keyword">delete</span> decoder;
</pre>
<p>The <a href="qtextdecoder.html">QTextDecoder</a> object
maintains state between chunks and therefore works correctly even
if a multi-byte character is split between chunks.</p>
<a id="creating-your-own-codec-class" name="creating-your-own-codec-class" />
<h3>Creating Your Own Codec Class</h3>
<p>Support for new text encodings can be added to Qt by creating
QTextCodec subclasses.</p>
<p>The pure virtual functions describe the encoder to the system
and the coder is used as required in the different text file
formats supported by <a href="qtextstream.html">QTextStream</a>,
and under X11, for the locale-specific character input and
output.</p>
<p>To add support for another encoding to Qt, make a subclass of
QTextCodec and implement the functions listed in the table
below.</p>
<table class="generic">
<thead>
<tr class="qt-style">
<th>Function</th>
<th>Description</th>
</tr>
</thead>
<tr class="odd" valign="top">
<td><a href="qtextcodec.html#name">name</a>()</td>
<td>Returns the official name for the encoding. If the encoding is
listed in the <a href="http://www.iana.org/assignments/character-sets">IANA
character-sets encoding file</a>, the name should be the preferred
MIME name for the encoding.</td>
</tr>
<tr class="even" valign="top">
<td><a href="qtextcodec.html#aliases">aliases</a>()</td>
<td>Returns a list of alternative names for the encoding.
QTextCodec provides a default implementation that returns an empty
list. For example, "ISO-8859-1" has "latin1", "CP819", "IBM819",
and "iso-ir-100" as aliases.</td>
</tr>
<tr class="odd" valign="top">
<td><a href="qtextcodec.html#mibEnum">mibEnum</a>()</td>
<td>Return the MIB enum for the encoding if it is listed in the
<a href="http://www.iana.org/assignments/character-sets">IANA
character-sets encoding file</a>.</td>
</tr>
<tr class="even" valign="top">
<td><a href="qtextcodec.html#convertToUnicode">convertToUnicode</a>()</td>
<td>Converts an 8-bit character string to Unicode.</td>
</tr>
<tr class="odd" valign="top">
<td><a href="qtextcodec.html#convertFromUnicode">convertFromUnicode</a>()</td>
<td>Converts a Unicode string to an 8-bit character string.</td>
</tr>
</table>
<p>You may find it more convenient to make your codec class
available as a plugin; see <a href="plugins-howto.html">How to
Create Qt Plugins</a> for details.</p>
<hr /><h2>Type Documentation</h2><h3 class="fn"><a name="ConversionFlag-enum" />QTextCodec.ConversionFlag</h3><table class="valuelist">
<tr class="odd" valign="top">
<th class="tblConst">Constant</th>
<th class="tblval">Value</th>
<th class="tbldscr">Description</th>
</tr>
<tr>
<td class="topAlign"><tt>QTextCodec.DefaultConversion</tt></td>
<td class="topAlign"><tt>0</tt></td>
<td class="topAlign">No flag is set.</td>
</tr>
<tr>
<td class="topAlign"><tt>QTextCodec.ConvertInvalidToNull</tt></td>
<td class="topAlign"><tt>0x80000000</tt></td>
<td class="topAlign">If this flag is set, each invalid input
character is output as a null character.</td>
</tr>
<tr>
<td class="topAlign"><tt>QTextCodec.IgnoreHeader</tt></td>
<td class="topAlign"><tt>0x1</tt></td>
<td class="topAlign">Ignore any Unicode byte-order mark and don't
generate any.</td>
</tr>
</table>
<p>The ConversionFlags type is a typedef for <a href="qflags.html">QFlags</a>&lt;ConversionFlag&gt;. It stores an OR
combination of ConversionFlag values.</p>
<hr /><h2>Method Documentation</h2><h3 class="fn"><a name="QTextCodec" />QTextCodec.__init__ (<i>self</i>)</h3><p>Constructs a <a href="qtextcodec.html">QTextCodec</a>, and gives
it the highest precedence. The <a href="qtextcodec.html">QTextCodec</a> should always be constructed on
the heap (i.e. with <tt>new</tt>). Qt takes ownership and will
delete it when the application terminates.</p>


<h3 class="fn"><a name="aliases" />list-of-QByteArray QTextCodec.aliases (<i>self</i>)</h3><p>Subclasses can return a number of aliases for the codec in
question.</p>
<p>Standard aliases for codecs can be found in the <a href="http://www.iana.org/assignments/character-sets">IANA
character-sets encoding file</a>.</p>


<h3 class="fn"><a name="availableCodecs" />list-of-QByteArray QTextCodec.availableCodecs ()</h3><p>Returns the list of all available codecs, by name. Call <a href="qtextcodec.html#codecForName">QTextCodec.codecForName</a>() to
obtain the <a href="qtextcodec.html">QTextCodec</a> for the
name.</p>
<p>The list may contain many mentions of the same codec if the
codec has aliases.</p>
<p><b>See also</b> <a href="qtextcodec.html#availableMibs">availableMibs</a>(), <a href="qtextcodec.html#name">name</a>(), and <a href="qtextcodec.html#aliases">aliases</a>().</p>


<h3 class="fn"><a name="availableMibs" />list-of-int QTextCodec.availableMibs ()</h3><p>Returns the list of MIBs for all available codecs. Call <a href="qtextcodec.html#codecForMib">QTextCodec.codecForMib</a>() to
obtain the <a href="qtextcodec.html">QTextCodec</a> for the
MIB.</p>
<p><b>See also</b> <a href="qtextcodec.html#availableCodecs">availableCodecs</a>() and
<a href="qtextcodec.html#mibEnum">mibEnum</a>().</p>


<h3 class="fn"><a name="canEncode" />bool QTextCodec.canEncode (<i>self</i>, QString)</h3><p>Returns true if the Unicode character <i>ch</i> can be fully
encoded with this codec; otherwise returns false.</p>


<h3 class="fn"><a name="codecForCStrings" /><a href="qtextcodec.html">QTextCodec</a> QTextCodec.codecForCStrings ()</h3><p>Returns the codec used by <a href="qstring.html">QString</a> to
convert to and from <tt>const char *</tt> and QByteArrays. If this
function returns 0 (the default), <a href="qstring.html">QString</a> assumes Latin-1.</p>
<p><b>See also</b> <a href="qtextcodec.html#setCodecForCStrings">setCodecForCStrings</a>().</p>


<h3 class="fn"><a name="codecForHtml" /><a href="qtextcodec.html">QTextCodec</a> QTextCodec.codecForHtml (<a href="qbytearray.html">QByteArray</a>&#160;<i>ba</i>)</h3><p>Tries to detect the encoding of the provided snippet of HTML in
the given byte array, <i>ba</i>, by checking the BOM (Byte Order
Mark) and the content-type meta header and returns a <a href="qtextcodec.html">QTextCodec</a> instance that is capable of
decoding the html to unicode. If the codec cannot be detected from
the content provided, <i>defaultCodec</i> is returned.</p>
<p>This function was introduced in Qt 4.4.</p>
<p><b>See also</b> <a href="qtextcodec.html#codecForUtfText">codecForUtfText</a>().</p>


<h3 class="fn"><a name="codecForHtml-2" /><a href="qtextcodec.html">QTextCodec</a> QTextCodec.codecForHtml (<a href="qbytearray.html">QByteArray</a>&#160;<i>ba</i>, <a href="qtextcodec.html">QTextCodec</a>&#160;<i>defaultCodec</i>)</h3><p>This is an overloaded function.</p>
<p>Tries to detect the encoding of the provided snippet of HTML in
the given byte array, <i>ba</i>, by checking the BOM (Byte Order
Mark) and the content-type meta header and returns a <a href="qtextcodec.html">QTextCodec</a> instance that is capable of
decoding the html to unicode. If the codec cannot be detected, this
overload returns a Latin-1 <a href="qtextcodec.html">QTextCodec</a>.</p>


<h3 class="fn"><a name="codecForLocale" /><a href="qtextcodec.html">QTextCodec</a> QTextCodec.codecForLocale ()</h3><p>Returns a pointer to the codec most suitable for this
locale.</p>
<p>On Windows, the codec will be based on a system locale. On Unix
systems, starting with Qt 4.2, the codec will be using the
<i>iconv</i> library. Note that in both cases the codec's name will
be "System".</p>
<p><b>See also</b> <a href="qtextcodec.html#setCodecForLocale">setCodecForLocale</a>().</p>


<h3 class="fn"><a name="codecForMib" /><a href="qtextcodec.html">QTextCodec</a> QTextCodec.codecForMib (int&#160;<i>mib</i>)</h3><p>Returns the <a href="qtextcodec.html">QTextCodec</a> which
matches the <a href="qtextcodec.html#mibEnum">MIBenum</a>
<i>mib</i>.</p>


<h3 class="fn"><a name="codecForName" /><a href="qtextcodec.html">QTextCodec</a> QTextCodec.codecForName (<a href="qbytearray.html">QByteArray</a>&#160;<i>name</i>)</h3><p>Searches all installed <a href="qtextcodec.html">QTextCodec</a>
objects and returns the one which best matches <i>name</i>; the
match is case-insensitive. Returns 0 if no codec matching the name
<i>name</i> could be found.</p>


<h3 class="fn"><a name="codecForName-2" /><a href="qtextcodec.html">QTextCodec</a> QTextCodec.codecForName (str&#160;<i>name</i>)</h3><p>Searches all installed <a href="qtextcodec.html">QTextCodec</a>
objects and returns the one which best matches <i>name</i>; the
match is case-insensitive. Returns 0 if no codec matching the name
<i>name</i> could be found.</p>


<h3 class="fn"><a name="codecForTr" /><a href="qtextcodec.html">QTextCodec</a> QTextCodec.codecForTr ()</h3><p>Returns the codec used by <a href="qobject.html#tr">QObject.tr</a>() on its argument. If this
function returns 0 (the default), tr() assumes Latin-1.</p>
<p><b>See also</b> <a href="qtextcodec.html#setCodecForTr">setCodecForTr</a>().</p>


<h3 class="fn"><a name="codecForUtfText" /><a href="qtextcodec.html">QTextCodec</a> QTextCodec.codecForUtfText (<a href="qbytearray.html">QByteArray</a>&#160;<i>ba</i>)</h3><p>Tries to detect the encoding of the provided snippet <i>ba</i>
by using the BOM (Byte Order Mark) and returns a <a href="qtextcodec.html">QTextCodec</a> instance that is capable of
decoding the text to unicode. If the codec cannot be detected from
the content provided, <i>defaultCodec</i> is returned.</p>
<p>This function was introduced in Qt 4.6.</p>
<p><b>See also</b> <a href="qtextcodec.html#codecForHtml">codecForHtml</a>().</p>


<h3 class="fn"><a name="codecForUtfText-2" /><a href="qtextcodec.html">QTextCodec</a> QTextCodec.codecForUtfText (<a href="qbytearray.html">QByteArray</a>&#160;<i>ba</i>, <a href="qtextcodec.html">QTextCodec</a>&#160;<i>defaultCodec</i>)</h3><p>This is an overloaded function.</p>
<p>Tries to detect the encoding of the provided snippet <i>ba</i>
by using the BOM (Byte Order Mark) and returns a <a href="qtextcodec.html">QTextCodec</a> instance that is capable of
decoding the text to unicode. If the codec cannot be detected, this
overload returns a Latin-1 <a href="qtextcodec.html">QTextCodec</a>.</p>
<p><b>See also</b> <a href="qtextcodec.html#codecForHtml">codecForHtml</a>().</p>


<h3 class="fn"><a name="convertToUnicode" />QString QTextCodec.convertToUnicode (<i>self</i>, str&#160;<i>in</i>, <a href="qtextcodec-converterstate.html">ConverterState</a>&#160;<i>state</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p><a href="qtextcodec.html">QTextCodec</a> subclasses must
reimplement this function.</p>
<p>Converts the first <i>len</i> characters of <i>chars</i> from
the encoding of the subclass to Unicode, and returns the result in
a <a href="qstring.html">QString</a>.</p>
<p><i>state</i> can be 0, in which case the conversion is stateless
and default conversion rules should be used. If state is not 0, the
codec should save the state after the conversion in <i>state</i>,
and adjust the remainingChars and invalidChars members of the
struct.</p>


<h3 class="fn"><a name="fromUnicode" /><a href="qbytearray.html">QByteArray</a> QTextCodec.fromUnicode (<i>self</i>, QString&#160;<i>uc</i>)</h3><p>Converts <i>str</i> from Unicode to the encoding of this codec,
and returns the result in a <a href="qbytearray.html">QByteArray</a>.</p>


<h3 class="fn"><a name="makeDecoder" /><a href="qtextdecoder.html">QTextDecoder</a> QTextCodec.makeDecoder (<i>self</i>)</h3><p>Creates a <a href="qtextdecoder.html">QTextDecoder</a> which
stores enough state to decode chunks of <tt>char *</tt> data to
create chunks of Unicode data.</p>
<p>The caller is responsible for deleting the returned object.</p>


<h3 class="fn"><a name="makeDecoder-2" /><a href="qtextdecoder.html">QTextDecoder</a> QTextCodec.makeDecoder (<i>self</i>, <a href="qtextcodec-conversionflags.html">ConversionFlags</a>&#160;<i>flags</i>)</h3><p>Creates a <a href="qtextdecoder.html">QTextDecoder</a> with a
specified <i>flags</i> to decode chunks of <tt>char *</tt> data to
create chunks of Unicode data.</p>
<p>The caller is responsible for deleting the returned object.</p>
<p>This function was introduced in Qt 4.7.</p>


<h3 class="fn"><a name="makeEncoder" /><a href="qtextencoder.html">QTextEncoder</a> QTextCodec.makeEncoder (<i>self</i>)</h3><p>Creates a <a href="qtextencoder.html">QTextEncoder</a> which
stores enough state to encode chunks of Unicode data as <tt>char
*</tt> data.</p>
<p>The caller is responsible for deleting the returned object.</p>


<h3 class="fn"><a name="makeEncoder-2" /><a href="qtextencoder.html">QTextEncoder</a> QTextCodec.makeEncoder (<i>self</i>, <a href="qtextcodec-conversionflags.html">ConversionFlags</a>&#160;<i>flags</i>)</h3><p>Creates a <a href="qtextencoder.html">QTextEncoder</a> with a
specified <i>flags</i> to encode chunks of Unicode data as <tt>char
*</tt> data.</p>
<p>The caller is responsible for deleting the returned object.</p>
<p>This function was introduced in Qt 4.7.</p>


<h3 class="fn"><a name="mibEnum" />int QTextCodec.mibEnum (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p>Subclasses of <a href="qtextcodec.html">QTextCodec</a> must
reimplement this function. It returns the MIBenum (see <a href="http://www.iana.org/assignments/character-sets">IANA
character-sets encoding file</a> for more information). It is
important that each <a href="qtextcodec.html">QTextCodec</a>
subclass returns the correct unique value for this function.</p>


<h3 class="fn"><a name="name" /><a href="qbytearray.html">QByteArray</a> QTextCodec.name (<i>self</i>)</h3><p>This method is abstract and should be reimplemented in any sub-class.</p><p><a href="qtextcodec.html">QTextCodec</a> subclasses must
reimplement this function. It returns the name of the encoding
supported by the subclass.</p>
<p>If the codec is registered as a character set in the <a href="http://www.iana.org/assignments/character-sets">IANA
character-sets encoding file</a> this method should return the
preferred mime name for the codec if defined, otherwise its
name.</p>


<h3 class="fn"><a name="setCodecForCStrings" />QTextCodec.setCodecForCStrings (<a href="qtextcodec.html">QTextCodec</a>&#160;<i>c</i>)</h3><p>Sets the codec used by <a href="qstring.html">QString</a> to
convert to and from <tt>const char *</tt> and QByteArrays. If the
<i>codec</i> is 0 (the default), <a href="qstring.html">QString</a>
assumes Latin-1.</p>
<p><b>Warning:</b> Some codecs do not preserve the characters in
the ASCII range (0x00 to 0x7F). For example, the Japanese Shift-JIS
encoding maps the backslash character (0x5A) to the Yen character.
To avoid undesirable side-effects, we recommend avoiding such
codecs with setCodecsForCString().</p>
<p><b>Warning:</b> This function is not <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
<p><b>See also</b> <a href="qtextcodec.html#codecForCStrings">codecForCStrings</a>() and
<a href="qtextcodec.html#setCodecForTr">setCodecForTr</a>().</p>


<h3 class="fn"><a name="setCodecForLocale" />QTextCodec.setCodecForLocale (<a href="qtextcodec.html">QTextCodec</a>&#160;<i>c</i>)</h3><p>Set the codec to <i>c</i>; this will be returned by <a href="qtextcodec.html#codecForLocale">codecForLocale</a>(). If <i>c</i>
is a null pointer, the codec is reset to the default.</p>
<p>This might be needed for some applications that want to use
their own mechanism for setting the locale.</p>
<p><b>See also</b> <a href="qtextcodec.html#codecForLocale">codecForLocale</a>().</p>


<h3 class="fn"><a name="setCodecForTr" />QTextCodec.setCodecForTr (<a href="qtextcodec.html">QTextCodec</a>&#160;<i>c</i>)</h3><p>Sets the codec used by <a href="qobject.html#tr">QObject.tr</a>() on its argument to <i>c</i>. If
<i>c</i> is 0 (the default), tr() assumes Latin-1.</p>
<p>If the literal quoted text in the program is not in the Latin-1
encoding, this function can be used to set the appropriate
encoding. For example, software developed by Korean programmers
might use eucKR for all the text in the program, in which case the
main() function might look like this:</p>
<pre class="cpp">
 <span class="type">int</span> main(<span class="type">int</span> argc<span class="operator">,</span> <span class="type">char</span> <span class="operator">*</span>argv<span class="operator">[</span><span class="operator">]</span>)
 {
     <span class="type"><a href="qapplication.html">QApplication</a></span> app(argc<span class="operator">,</span> argv);
     <span class="type"><a href="qtextcodec.html">QTextCodec</a></span><span class="operator">.</span>setCodecForTr(<span class="type"><a href="qtextcodec.html">QTextCodec</a></span><span class="operator">.</span>codecForName(<span class="string">"eucKR"</span>));
     <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
 }
</pre>
<p>Note that this is not the way to select the encoding that the
<i>user</i> has chosen. For example, to convert an application
containing literal English strings to Korean, all that is needed is
for the English strings to be passed through tr() and for
translation files to be loaded. For details of
internationalization, see <a href="internationalization.html">Internationalization with Qt</a>.</p>
<p><b>Warning:</b> This function is not <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
<p><b>See also</b> <a href="qtextcodec.html#codecForTr">codecForTr</a>() and <a href="qtextcodec.html#setCodecForCStrings">setCodecForCStrings</a>().</p>


<h3 class="fn"><a name="toUnicode" />QString QTextCodec.toUnicode (<i>self</i>, <a href="qbytearray.html">QByteArray</a>)</h3><p>Converts <i>a</i> from the encoding of this codec to Unicode,
and returns the result in a <a href="qstring.html">QString</a>.</p>


<h3 class="fn"><a name="toUnicode-2" />QString QTextCodec.toUnicode (<i>self</i>, str&#160;<i>chars</i>)</h3><p>Converts the first <i>size</i> characters from the <i>input</i>
from the encoding of this codec to Unicode, and returns the result
in a <a href="qstring.html">QString</a>.</p>
<p>The <i>state</i> of the convertor used is updated.</p>


<h3 class="fn"><a name="toUnicode-3" />QString QTextCodec.toUnicode (<i>self</i>, str&#160;<i>in</i>, <a href="qtextcodec-converterstate.html">ConverterState</a>&#160;<i>state</i>&#160;=&#160;None)</h3><address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt&#160;4.9.1 for X11</td><td align="center" width="50%">Copyright &#169; <a href="http://www.riverbankcomputing.com">Riverbank&#160;Computing&#160;Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2011</td><td align="right" width="25%">Qt&#160;4.8.0</td></tr></table></div></address></body></html>